home *** CD-ROM | disk | FTP | other *** search
/ Ultra Pack / UltraComputing Partner Applications.iso / SunLabs / tclTK / src / tk4.0 / tkConfig.c < prev    next >
C/C++ Source or Header  |  1995-05-03  |  28KB  |  997 lines
  1. /* 
  2.  * tkConfig.c --
  3.  *
  4.  *    This file contains the Tk_ConfigureWidget procedure.
  5.  *
  6.  * Copyright (c) 1990-1994 The Regents of the University of California.
  7.  * Copyright (c) 1994-1995 Sun Microsystems, Inc.
  8.  *
  9.  * See the file "license.terms" for information on usage and redistribution
  10.  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  11.  */
  12.  
  13. static char sccsid[] = "@(#) tkConfig.c 1.49 95/05/03 08:23:50";
  14.  
  15. #include "tkPort.h"
  16. #include "tk.h"
  17.  
  18. /*
  19.  * Values for "flags" field of Tk_ConfigSpec structures.  Be sure
  20.  * to coordinate these values with those defined in tk.h
  21.  * (TK_CONFIG_COLOR_ONLY, etc.).  There must not be overlap!
  22.  *
  23.  * INIT -        Non-zero means (char *) things have been
  24.  *            converted to Tk_Uid's.
  25.  */
  26.  
  27. #define INIT        0x20
  28.  
  29. /*
  30.  * Forward declarations for procedures defined later in this file:
  31.  */
  32.  
  33. static int        DoConfig _ANSI_ARGS_((Tcl_Interp *interp,
  34.                 Tk_Window tkwin, Tk_ConfigSpec *specPtr,
  35.                 Tk_Uid value, int valueIsUid, char *widgRec));
  36. static Tk_ConfigSpec *    FindConfigSpec _ANSI_ARGS_((Tcl_Interp *interp,
  37.                 Tk_ConfigSpec *specs, char *argvName,
  38.                 int needFlags, int hateFlags));
  39. static char *        FormatConfigInfo _ANSI_ARGS_((Tcl_Interp *interp,
  40.                 Tk_Window tkwin, Tk_ConfigSpec *specPtr,
  41.                 char *widgRec));
  42. static char *        FormatConfigValue _ANSI_ARGS_((Tcl_Interp *interp,
  43.                 Tk_Window tkwin, Tk_ConfigSpec *specPtr,
  44.                 char *widgRec, char *buffer,
  45.                 Tcl_FreeProc **freeProcPtr));
  46.  
  47. /*
  48.  *--------------------------------------------------------------
  49.  *
  50.  * Tk_ConfigureWidget --
  51.  *
  52.  *    Process command-line options and database options to
  53.  *    fill in fields of a widget record with resources and
  54.  *    other parameters.
  55.  *
  56.  * Results:
  57.  *    A standard Tcl return value.  In case of an error,
  58.  *    interp->result will hold an error message.
  59.  *
  60.  * Side effects:
  61.  *    The fields of widgRec get filled in with information
  62.  *    from argc/argv and the option database.  Old information
  63.  *    in widgRec's fields gets recycled.
  64.  *
  65.  *--------------------------------------------------------------
  66.  */
  67.  
  68. int
  69. Tk_ConfigureWidget(interp, tkwin, specs, argc, argv, widgRec, flags)
  70.     Tcl_Interp *interp;        /* Interpreter for error reporting. */
  71.     Tk_Window tkwin;        /* Window containing widget (needed to
  72.                  * set up X resources). */
  73.     Tk_ConfigSpec *specs;    /* Describes legal options. */
  74.     int argc;            /* Number of elements in argv. */
  75.     char **argv;        /* Command-line options. */
  76.     char *widgRec;        /* Record whose fields are to be
  77.                  * modified.  Values must be properly
  78.                  * initialized. */
  79.     int flags;            /* Used to specify additional flags
  80.                  * that must be present in config specs
  81.                  * for them to be considered.  Also,
  82.                  * may have TK_CONFIG_ARGV_ONLY set. */
  83. {
  84.     register Tk_ConfigSpec *specPtr;
  85.     Tk_Uid value;        /* Value of option from database. */
  86.     int needFlags;        /* Specs must contain this set of flags
  87.                  * or else they are not considered. */
  88.     int hateFlags;        /* If a spec contains any bits here, it's
  89.                  * not considered. */
  90.  
  91.     needFlags = flags & ~(TK_CONFIG_USER_BIT - 1);
  92.     if (Tk_Depth(tkwin) <= 1) {
  93.     hateFlags = TK_CONFIG_COLOR_ONLY;
  94.     } else {
  95.     hateFlags = TK_CONFIG_MONO_ONLY;
  96.     }
  97.  
  98.     /*
  99.      * Pass one:  scan through all the option specs, replacing strings
  100.      * with Tk_Uids (if this hasn't been done already) and clearing
  101.      * the TK_CONFIG_OPTION_SPECIFIED flags.
  102.      */
  103.  
  104.     for (specPtr = specs; specPtr->type != TK_CONFIG_END; specPtr++) {
  105.     if (!(specPtr->specFlags & INIT) && (specPtr->argvName != NULL)) {
  106.         if (specPtr->dbName != NULL) {
  107.         specPtr->dbName = Tk_GetUid(specPtr->dbName);
  108.         }
  109.         if (specPtr->dbClass != NULL) {
  110.         specPtr->dbClass = Tk_GetUid(specPtr->dbClass);
  111.         }
  112.         if (specPtr->defValue != NULL) {
  113.         specPtr->defValue = Tk_GetUid(specPtr->defValue);
  114.         }
  115.     }
  116.     specPtr->specFlags = (specPtr->specFlags & ~TK_CONFIG_OPTION_SPECIFIED)
  117.         | INIT;
  118.     }
  119.  
  120.     /*
  121.      * Pass two:  scan through all of the arguments, processing those
  122.      * that match entries in the specs.
  123.      */
  124.  
  125.     for ( ; argc > 0; argc -= 2, argv += 2) {
  126.     specPtr = FindConfigSpec(interp, specs, *argv, needFlags, hateFlags);
  127.     if (specPtr == NULL) {
  128.         return TCL_ERROR;
  129.     }
  130.  
  131.     /*
  132.      * Process the entry.
  133.      */
  134.  
  135.     if (argc < 2) {
  136.         Tcl_AppendResult(interp, "value for \"", *argv,
  137.             "\" missing", (char *) NULL);
  138.         return TCL_ERROR;
  139.     }
  140.     if (DoConfig(interp, tkwin, specPtr, argv[1], 0, widgRec) != TCL_OK) {
  141.         char msg[100];
  142.  
  143.         sprintf(msg, "\n    (processing \"%.40s\" option)",
  144.             specPtr->argvName);
  145.         Tcl_AddErrorInfo(interp, msg);
  146.         return TCL_ERROR;
  147.     }
  148.     specPtr->specFlags |= TK_CONFIG_OPTION_SPECIFIED;
  149.     }
  150.  
  151.     /*
  152.      * Pass three:  scan through all of the specs again;  if no
  153.      * command-line argument matched a spec, then check for info
  154.      * in the option database.  If there was nothing in the
  155.      * database, then use the default.
  156.      */
  157.  
  158.     if (!(flags & TK_CONFIG_ARGV_ONLY)) {
  159.     for (specPtr = specs; specPtr->type != TK_CONFIG_END; specPtr++) {
  160.         if ((specPtr->specFlags & TK_CONFIG_OPTION_SPECIFIED)
  161.             || (specPtr->argvName == NULL)
  162.             || (specPtr->type == TK_CONFIG_SYNONYM)) {
  163.         continue;
  164.         }
  165.         if (((specPtr->specFlags & needFlags) != needFlags)
  166.             || (specPtr->specFlags & hateFlags)) {
  167.         continue;
  168.         }
  169.         value = NULL;
  170.         if (specPtr->dbName != NULL) {
  171.         value = Tk_GetOption(tkwin, specPtr->dbName, specPtr->dbClass);
  172.         }
  173.         if (value != NULL) {
  174.         if (DoConfig(interp, tkwin, specPtr, value, 1, widgRec) !=
  175.             TCL_OK) {
  176.             char msg[200];
  177.     
  178.             sprintf(msg, "\n    (%s \"%.50s\" in widget \"%.50s\")",
  179.                 "database entry for",
  180.                 specPtr->dbName, Tk_PathName(tkwin));
  181.             Tcl_AddErrorInfo(interp, msg);
  182.             return TCL_ERROR;
  183.         }
  184.         } else {
  185.         value = specPtr->defValue;
  186.         if ((value != NULL) && !(specPtr->specFlags
  187.             & TK_CONFIG_DONT_SET_DEFAULT)) {
  188.             if (DoConfig(interp, tkwin, specPtr, value, 1, widgRec) !=
  189.                 TCL_OK) {
  190.             char msg[200];
  191.     
  192.             sprintf(msg,
  193.                 "\n    (%s \"%.50s\" in widget \"%.50s\")",
  194.                 "default value for",
  195.                 specPtr->dbName, Tk_PathName(tkwin));
  196.             Tcl_AddErrorInfo(interp, msg);
  197.             return TCL_ERROR;
  198.             }
  199.         }
  200.         }
  201.     }
  202.     }
  203.  
  204.     return TCL_OK;
  205. }
  206.  
  207. /*
  208.  *--------------------------------------------------------------
  209.  *
  210.  * FindConfigSpec --
  211.  *
  212.  *    Search through a table of configuration specs, looking for
  213.  *    one that matches a given argvName.
  214.  *
  215.  * Results:
  216.  *    The return value is a pointer to the matching entry, or NULL
  217.  *    if nothing matched.  In that case an error message is left
  218.  *    in interp->result.
  219.  *
  220.  * Side effects:
  221.  *    None.
  222.  *
  223.  *--------------------------------------------------------------
  224.  */
  225.  
  226. static Tk_ConfigSpec *
  227. FindConfigSpec(interp, specs, argvName, needFlags, hateFlags)
  228.     Tcl_Interp *interp;        /* Used for reporting errors. */
  229.     Tk_ConfigSpec *specs;    /* Pointer to table of configuration
  230.                  * specifications for a widget. */
  231.     char *argvName;        /* Name (suitable for use in a "config"
  232.                  * command) identifying particular option. */
  233.     int needFlags;        /* Flags that must be present in matching
  234.                  * entry. */
  235.     int hateFlags;        /* Flags that must NOT be present in
  236.                  * matching entry. */
  237. {
  238.     register Tk_ConfigSpec *specPtr;
  239.     register char c;        /* First character of current argument. */
  240.     Tk_ConfigSpec *matchPtr;    /* Matching spec, or NULL. */
  241.     size_t length;
  242.  
  243.     c = argvName[1];
  244.     length = strlen(argvName);
  245.     matchPtr = NULL;
  246.     for (specPtr = specs; specPtr->type != TK_CONFIG_END; specPtr++) {
  247.     if (specPtr->argvName == NULL) {
  248.         continue;
  249.     }
  250.     if ((specPtr->argvName[1] != c)
  251.         || (strncmp(specPtr->argvName, argvName, length) != 0)) {
  252.         continue;
  253.     }
  254.     if (((specPtr->specFlags & needFlags) != needFlags)
  255.         || (specPtr->specFlags & hateFlags)) {
  256.         continue;
  257.     }
  258.     if (specPtr->argvName[length] == 0) {
  259.         matchPtr = specPtr;
  260.         goto gotMatch;
  261.     }
  262.     if (matchPtr != NULL) {
  263.         Tcl_AppendResult(interp, "ambiguous option \"", argvName,
  264.             "\"", (char *) NULL);
  265.         return (Tk_ConfigSpec *) NULL;
  266.     }
  267.     matchPtr = specPtr;
  268.     }
  269.  
  270.     if (matchPtr == NULL) {
  271.     Tcl_AppendResult(interp, "unknown option \"", argvName,
  272.         "\"", (char *) NULL);
  273.     return (Tk_ConfigSpec *) NULL;
  274.     }
  275.  
  276.     /*
  277.      * Found a matching entry.  If it's a synonym, then find the
  278.      * entry that it's a synonym for.
  279.      */
  280.  
  281.     gotMatch:
  282.     specPtr = matchPtr;
  283.     if (specPtr->type == TK_CONFIG_SYNONYM) {
  284.     for (specPtr = specs; ; specPtr++) {
  285.         if (specPtr->type == TK_CONFIG_END) {
  286.         Tcl_AppendResult(interp,
  287.             "couldn't find synonym for option \"",
  288.             argvName, "\"", (char *) NULL);
  289.         return (Tk_ConfigSpec *) NULL;
  290.         }
  291.         if ((specPtr->dbName == matchPtr->dbName) 
  292.             && (specPtr->type != TK_CONFIG_SYNONYM)
  293.             && ((specPtr->specFlags & needFlags) == needFlags)
  294.             && !(specPtr->specFlags & hateFlags)) {
  295.         break;
  296.         }
  297.     }
  298.     }
  299.     return specPtr;
  300. }
  301.  
  302. /*
  303.  *--------------------------------------------------------------
  304.  *
  305.  * DoConfig --
  306.  *
  307.  *    This procedure applies a single configuration option
  308.  *    to a widget record.
  309.  *
  310.  * Results:
  311.  *    A standard Tcl return value.
  312.  *
  313.  * Side effects:
  314.  *    WidgRec is modified as indicated by specPtr and value.
  315.  *    The old value is recycled, if that is appropriate for
  316.  *    the value type.
  317.  *
  318.  *--------------------------------------------------------------
  319.  */
  320.  
  321. static int
  322. DoConfig(interp, tkwin, specPtr, value, valueIsUid, widgRec)
  323.     Tcl_Interp *interp;        /* Interpreter for error reporting. */
  324.     Tk_Window tkwin;        /* Window containing widget (needed to
  325.                  * set up X resources). */
  326.     Tk_ConfigSpec *specPtr;    /* Specifier to apply. */
  327.     char *value;        /* Value to use to fill in widgRec. */
  328.     int valueIsUid;        /* Non-zero means value is a Tk_Uid;
  329.                  * zero means it's an ordinary string. */
  330.     char *widgRec;        /* Record whose fields are to be
  331.                  * modified.  Values must be properly
  332.                  * initialized. */
  333. {
  334.     char *ptr;
  335.     Tk_Uid uid;
  336.     int nullValue;
  337.  
  338.     nullValue = 0;
  339.     if ((*value == 0) && (specPtr->specFlags & TK_CONFIG_NULL_OK)) {
  340.     nullValue = 1;
  341.     }
  342.  
  343.     do {
  344.     ptr = widgRec + specPtr->offset;
  345.     switch (specPtr->type) {
  346.         case TK_CONFIG_BOOLEAN:
  347.         if (Tcl_GetBoolean(interp, value, (int *) ptr) != TCL_OK) {
  348.             return TCL_ERROR;
  349.         }
  350.         break;
  351.         case TK_CONFIG_INT:
  352.         if (Tcl_GetInt(interp, value, (int *) ptr) != TCL_OK) {
  353.             return TCL_ERROR;
  354.         }
  355.         break;
  356.         case TK_CONFIG_DOUBLE:
  357.         if (Tcl_GetDouble(interp, value, (double *) ptr) != TCL_OK) {
  358.             return TCL_ERROR;
  359.         }
  360.         break;
  361.         case TK_CONFIG_STRING: {
  362.         char *old, *new;
  363.  
  364.         if (nullValue) {
  365.             new = NULL;
  366.         } else {
  367.             new = (char *) ckalloc((unsigned) (strlen(value) + 1));
  368.             strcpy(new, value);
  369.         }
  370.         old = *((char **) ptr);
  371.         if (old != NULL) {
  372.             ckfree(old);
  373.         }
  374.         *((char **) ptr) = new;
  375.         break;
  376.         }
  377.         case TK_CONFIG_UID:
  378.         if (nullValue) {
  379.             *((Tk_Uid *) ptr) = NULL;
  380.         } else {
  381.             uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  382.             *((Tk_Uid *) ptr) = uid;
  383.         }
  384.         break;
  385.         case TK_CONFIG_COLOR: {
  386.         XColor *newPtr, *oldPtr;
  387.  
  388.         if (nullValue) {
  389.             newPtr = NULL;
  390.         } else {
  391.             uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  392.             newPtr = Tk_GetColor(interp, tkwin, uid);
  393.             if (newPtr == NULL) {
  394.             return TCL_ERROR;
  395.             }
  396.         }
  397.         oldPtr = *((XColor **) ptr);
  398.         if (oldPtr != NULL) {
  399.             Tk_FreeColor(oldPtr);
  400.         }
  401.         *((XColor **) ptr) = newPtr;
  402.         break;
  403.         }
  404.         case TK_CONFIG_FONT: {
  405.         XFontStruct *newPtr, *oldPtr;
  406.  
  407.         if (nullValue) {
  408.             newPtr = NULL;
  409.         } else {
  410.             uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  411.             newPtr = Tk_GetFontStruct(interp, tkwin, uid);
  412.             if (newPtr == NULL) {
  413.             return TCL_ERROR;
  414.             }
  415.         }
  416.         oldPtr = *((XFontStruct **) ptr);
  417.         if (oldPtr != NULL) {
  418.             Tk_FreeFontStruct(oldPtr);
  419.         }
  420.         *((XFontStruct **) ptr) = newPtr;
  421.         break;
  422.         }
  423.         case TK_CONFIG_BITMAP: {
  424.         Pixmap new, old;
  425.  
  426.         if (nullValue) {
  427.             new = None;
  428.             } else {
  429.             uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  430.             new = Tk_GetBitmap(interp, tkwin, uid);
  431.             if (new == None) {
  432.             return TCL_ERROR;
  433.             }
  434.         }
  435.         old = *((Pixmap *) ptr);
  436.         if (old != None) {
  437.             Tk_FreeBitmap(Tk_Display(tkwin), old);
  438.         }
  439.         *((Pixmap *) ptr) = new;
  440.         break;
  441.         }
  442.         case TK_CONFIG_BORDER: {
  443.         Tk_3DBorder new, old;
  444.  
  445.         if (nullValue) {
  446.             new = NULL;
  447.         } else {
  448.             uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  449.             new = Tk_Get3DBorder(interp, tkwin, uid);
  450.             if (new == NULL) {
  451.             return TCL_ERROR;
  452.             }
  453.         }
  454.         old = *((Tk_3DBorder *) ptr);
  455.         if (old != NULL) {
  456.             Tk_Free3DBorder(old);
  457.         }
  458.         *((Tk_3DBorder *) ptr) = new;
  459.         break;
  460.         }
  461.         case TK_CONFIG_RELIEF:
  462.         uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  463.         if (Tk_GetRelief(interp, uid, (int *) ptr) != TCL_OK) {
  464.             return TCL_ERROR;
  465.         }
  466.         break;
  467.         case TK_CONFIG_CURSOR:
  468.         case TK_CONFIG_ACTIVE_CURSOR: {
  469.         Cursor new, old;
  470.  
  471.         if (nullValue) {
  472.             new = None;
  473.         } else {
  474.             uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  475.             new = Tk_GetCursor(interp, tkwin, uid);
  476.             if (new == None) {
  477.             return TCL_ERROR;
  478.             }
  479.         }
  480.         old = *((Cursor *) ptr);
  481.         if (old != None) {
  482.             Tk_FreeCursor(Tk_Display(tkwin), old);
  483.         }
  484.         *((Cursor *) ptr) = new;
  485.         if (specPtr->type == TK_CONFIG_ACTIVE_CURSOR) {
  486.             Tk_DefineCursor(tkwin, new);
  487.         }
  488.         break;
  489.         }
  490.         case TK_CONFIG_JUSTIFY:
  491.         uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  492.         if (Tk_GetJustify(interp, uid, (Tk_Justify *) ptr) != TCL_OK) {
  493.             return TCL_ERROR;
  494.         }
  495.         break;
  496.         case TK_CONFIG_ANCHOR:
  497.         uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  498.         if (Tk_GetAnchor(interp, uid, (Tk_Anchor *) ptr) != TCL_OK) {
  499.             return TCL_ERROR;
  500.         }
  501.         break;
  502.         case TK_CONFIG_CAP_STYLE:
  503.         uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  504.         if (Tk_GetCapStyle(interp, uid, (int *) ptr) != TCL_OK) {
  505.             return TCL_ERROR;
  506.         }
  507.         break;
  508.         case TK_CONFIG_JOIN_STYLE:
  509.         uid = valueIsUid ? (Tk_Uid) value : Tk_GetUid(value);
  510.         if (Tk_GetJoinStyle(interp, uid, (int *) ptr) != TCL_OK) {
  511.             return TCL_ERROR;
  512.         }
  513.         break;
  514.         case TK_CONFIG_PIXELS:
  515.         if (Tk_GetPixels(interp, tkwin, value, (int *) ptr)
  516.             != TCL_OK) {
  517.             return TCL_ERROR;
  518.         }
  519.         break;
  520.         case TK_CONFIG_MM:
  521.         if (Tk_GetScreenMM(interp, tkwin, value, (double *) ptr)
  522.             != TCL_OK) {
  523.             return TCL_ERROR;
  524.         }
  525.         break;
  526.         case TK_CONFIG_WINDOW: {
  527.         Tk_Window tkwin2;
  528.  
  529.         if (nullValue) {
  530.             tkwin2 = NULL;
  531.         } else {
  532.             tkwin2 = Tk_NameToWindow(interp, value, tkwin);
  533.             if (tkwin2 == NULL) {
  534.             return TCL_ERROR;
  535.             }
  536.         }
  537.         *((Tk_Window *) ptr) = tkwin2;
  538.         break;
  539.         }
  540.         case TK_CONFIG_CUSTOM:
  541.         if ((*specPtr->customPtr->parseProc)(
  542.             specPtr->customPtr->clientData, interp, tkwin,
  543.             value, widgRec, specPtr->offset) != TCL_OK) {
  544.             return TCL_ERROR;
  545.         }
  546.         break;
  547.         default: {
  548.         sprintf(interp->result, "bad config table: unknown type %d",
  549.             specPtr->type);
  550.         return TCL_ERROR;
  551.         }
  552.     }
  553.     specPtr++;
  554.     } while ((specPtr->argvName == NULL) && (specPtr->type != TK_CONFIG_END));
  555.     return TCL_OK;
  556. }
  557.  
  558. /*
  559.  *--------------------------------------------------------------
  560.  *
  561.  * Tk_ConfigureInfo --
  562.  *
  563.  *    Return information about the configuration options
  564.  *    for a window, and their current values.
  565.  *
  566.  * Results:
  567.  *    Always returns TCL_OK.  Interp->result will be modified
  568.  *    hold a description of either a single configuration option
  569.  *    available for "widgRec" via "specs", or all the configuration
  570.  *    options available.  In the "all" case, the result will
  571.  *    available for "widgRec" via "specs".  The result will
  572.  *    be a list, each of whose entries describes one option.
  573.  *    Each entry will itself be a list containing the option's
  574.  *    name for use on command lines, database name, database
  575.  *    class, default value, and current value (empty string
  576.  *    if none).  For options that are synonyms, the list will
  577.  *    contain only two values:  name and synonym name.  If the
  578.  *    "name" argument is non-NULL, then the only information
  579.  *    returned is that for the named argument (i.e. the corresponding
  580.  *    entry in the overall list is returned).
  581.  *
  582.  * Side effects:
  583.  *    None.
  584.  *
  585.  *--------------------------------------------------------------
  586.  */
  587.  
  588. int
  589. Tk_ConfigureInfo(interp, tkwin, specs, widgRec, argvName, flags)
  590.     Tcl_Interp *interp;        /* Interpreter for error reporting. */
  591.     Tk_Window tkwin;        /* Window corresponding to widgRec. */
  592.     Tk_ConfigSpec *specs;    /* Describes legal options. */
  593.     char *widgRec;        /* Record whose fields contain current
  594.                  * values for options. */
  595.     char *argvName;        /* If non-NULL, indicates a single option
  596.                  * whose info is to be returned.  Otherwise
  597.                  * info is returned for all options. */
  598.     int flags;            /* Used to specify additional flags
  599.                  * that must be present in config specs
  600.                  * for them to be considered. */
  601. {
  602.     register Tk_ConfigSpec *specPtr;
  603.     int needFlags, hateFlags;
  604.     char *list;
  605.     char *leader = "{";
  606.  
  607.     needFlags = flags & ~(TK_CONFIG_USER_BIT - 1);
  608.     if (Tk_Depth(tkwin) <= 1) {
  609.     hateFlags = TK_CONFIG_COLOR_ONLY;
  610.     } else {
  611.     hateFlags = TK_CONFIG_MONO_ONLY;
  612.     }
  613.  
  614.     /*
  615.      * If information is only wanted for a single configuration
  616.      * spec, then handle that one spec specially.
  617.      */
  618.  
  619.     Tcl_SetResult(interp, (char *) NULL, TCL_STATIC);
  620.     if (argvName != NULL) {
  621.     specPtr = FindConfigSpec(interp, specs, argvName, needFlags,
  622.         hateFlags);
  623.     if (specPtr == NULL) {
  624.         return TCL_ERROR;
  625.     }
  626.     interp->result = FormatConfigInfo(interp, tkwin, specPtr, widgRec);
  627.     interp->freeProc = (Tcl_FreeProc *) free;
  628.     return TCL_OK;
  629.     }
  630.  
  631.     /*
  632.      * Loop through all the specs, creating a big list with all
  633.      * their information.
  634.      */
  635.  
  636.     for (specPtr = specs; specPtr->type != TK_CONFIG_END; specPtr++) {
  637.     if ((argvName != NULL) && (specPtr->argvName != argvName)) {
  638.         continue;
  639.     }
  640.     if (((specPtr->specFlags & needFlags) != needFlags)
  641.         || (specPtr->specFlags & hateFlags)) {
  642.         continue;
  643.     }
  644.     if (specPtr->argvName == NULL) {
  645.         continue;
  646.     }
  647.     list = FormatConfigInfo(interp, tkwin, specPtr, widgRec);
  648.     Tcl_AppendResult(interp, leader, list, "}", (char *) NULL);
  649.     ckfree(list);
  650.     leader = " {";
  651.     }
  652.     return TCL_OK;
  653. }
  654.  
  655. /*
  656.  *--------------------------------------------------------------
  657.  *
  658.  * FormatConfigInfo --
  659.  *
  660.  *    Create a valid Tcl list holding the configuration information
  661.  *    for a single configuration option.
  662.  *
  663.  * Results:
  664.  *    A Tcl list, dynamically allocated.  The caller is expected to
  665.  *    arrange for this list to be freed eventually.
  666.  *
  667.  * Side effects:
  668.  *    Memory is allocated.
  669.  *
  670.  *--------------------------------------------------------------
  671.  */
  672.  
  673. static char *
  674. FormatConfigInfo(interp, tkwin, specPtr, widgRec)
  675.     Tcl_Interp *interp;            /* Interpreter to use for things
  676.                      * like floating-point precision. */
  677.     Tk_Window tkwin;            /* Window corresponding to widget. */
  678.     register Tk_ConfigSpec *specPtr;    /* Pointer to information describing
  679.                      * option. */
  680.     char *widgRec;            /* Pointer to record holding current
  681.                      * values of info for widget. */
  682. {
  683.     char *argv[6], *result;
  684.     char buffer[200];
  685.     Tcl_FreeProc *freeProc = (Tcl_FreeProc *) NULL;
  686.  
  687.     argv[0] = specPtr->argvName;
  688.     argv[1] = specPtr->dbName;
  689.     argv[2] = specPtr->dbClass;
  690.     argv[3] = specPtr->defValue;
  691.     if (specPtr->type == TK_CONFIG_SYNONYM) {
  692.     return Tcl_Merge(2, argv);
  693.     }
  694.     argv[4] = FormatConfigValue(interp, tkwin, specPtr, widgRec, buffer,
  695.         &freeProc);
  696.     if (argv[1] == NULL) {
  697.     argv[1] = "";
  698.     }
  699.     if (argv[2] == NULL) {
  700.     argv[2] = "";
  701.     }
  702.     if (argv[3] == NULL) {
  703.     argv[3] = "";
  704.     }
  705.     if (argv[4] == NULL) {
  706.     argv[4] = "";
  707.     }
  708.     result = Tcl_Merge(5, argv);
  709.     if (freeProc != NULL) {
  710.     if (freeProc == (Tcl_FreeProc *) free) {
  711.         ckfree(argv[4]);
  712.     } else {
  713.         (*freeProc)(argv[4]);
  714.     }
  715.     }
  716.     return result;
  717. }
  718.  
  719. /*
  720.  *----------------------------------------------------------------------
  721.  *
  722.  * FormatConfigValue --
  723.  *
  724.  *    This procedure formats the current value of a configuration
  725.  *    option.
  726.  *
  727.  * Results:
  728.  *    The return value is the formatted value of the option given
  729.  *    by specPtr and widgRec.  If the value is static, so that it
  730.  *    need not be freed, *freeProcPtr will be set to NULL;  otherwise
  731.  *    *freeProcPtr will be set to the address of a procedure to
  732.  *    free the result, and the caller must invoke this procedure
  733.  *    when it is finished with the result.
  734.  *
  735.  * Side effects:
  736.  *    None.
  737.  *
  738.  *----------------------------------------------------------------------
  739.  */
  740.  
  741. static char *
  742. FormatConfigValue(interp, tkwin, specPtr, widgRec, buffer, freeProcPtr)
  743.     Tcl_Interp *interp;        /* Interpreter for use in real conversions. */
  744.     Tk_Window tkwin;        /* Window corresponding to widget. */
  745.     Tk_ConfigSpec *specPtr;    /* Pointer to information describing option.
  746.                  * Must not point to a synonym option. */
  747.     char *widgRec;        /* Pointer to record holding current
  748.                  * values of info for widget. */
  749.     char *buffer;        /* Static buffer to use for small values.
  750.                  * Must have at least 200 bytes of storage. */
  751.     Tcl_FreeProc **freeProcPtr;    /* Pointer to word to fill in with address
  752.                  * of procedure to free the result, or NULL
  753.                  * if result is static. */
  754. {
  755.     char *ptr, *result;
  756.  
  757.     *freeProcPtr = NULL;
  758.     ptr = widgRec + specPtr->offset;
  759.     result = "";
  760.     switch (specPtr->type) {
  761.     case TK_CONFIG_BOOLEAN:
  762.         if (*((int *) ptr) == 0) {
  763.         result = "0";
  764.         } else {
  765.         result = "1";
  766.         }
  767.         break;
  768.     case TK_CONFIG_INT:
  769.         sprintf(buffer, "%d", *((int *) ptr));
  770.         result = buffer;
  771.         break;
  772.     case TK_CONFIG_DOUBLE:
  773.         Tcl_PrintDouble(interp, *((double *) ptr), buffer);
  774.         result = buffer;
  775.         break;
  776.     case TK_CONFIG_STRING:
  777.         result = (*(char **) ptr);
  778.         if (result == NULL) {
  779.         result = "";
  780.         }
  781.         break;
  782.     case TK_CONFIG_UID: {
  783.         Tk_Uid uid = *((Tk_Uid *) ptr);
  784.         if (uid != NULL) {
  785.         result = uid;
  786.         }
  787.         break;
  788.     }
  789.     case TK_CONFIG_COLOR: {
  790.         XColor *colorPtr = *((XColor **) ptr);
  791.         if (colorPtr != NULL) {
  792.         result = Tk_NameOfColor(colorPtr);
  793.         }
  794.         break;
  795.     }
  796.     case TK_CONFIG_FONT: {
  797.         XFontStruct *fontStructPtr = *((XFontStruct **) ptr);
  798.         if (fontStructPtr != NULL) {
  799.         result = Tk_NameOfFontStruct(fontStructPtr);
  800.         }
  801.         break;
  802.     }
  803.     case TK_CONFIG_BITMAP: {
  804.         Pixmap pixmap = *((Pixmap *) ptr);
  805.         if (pixmap != None) {
  806.         result = Tk_NameOfBitmap(Tk_Display(tkwin), pixmap);
  807.         }
  808.         break;
  809.     }
  810.     case TK_CONFIG_BORDER: {
  811.         Tk_3DBorder border = *((Tk_3DBorder *) ptr);
  812.         if (border != NULL) {
  813.         result = Tk_NameOf3DBorder(border);
  814.         }
  815.         break;
  816.     }
  817.     case TK_CONFIG_RELIEF:
  818.         result = Tk_NameOfRelief(*((int *) ptr));
  819.         break;
  820.     case TK_CONFIG_CURSOR:
  821.     case TK_CONFIG_ACTIVE_CURSOR: {
  822.         Cursor cursor = *((Cursor *) ptr);
  823.         if (cursor != None) {
  824.         result = Tk_NameOfCursor(Tk_Display(tkwin), cursor);
  825.         }
  826.         break;
  827.     }
  828.     case TK_CONFIG_JUSTIFY:
  829.         result = Tk_NameOfJustify(*((Tk_Justify *) ptr));
  830.         break;
  831.     case TK_CONFIG_ANCHOR:
  832.         result = Tk_NameOfAnchor(*((Tk_Anchor *) ptr));
  833.         break;
  834.     case TK_CONFIG_CAP_STYLE:
  835.         result = Tk_NameOfCapStyle(*((int *) ptr));
  836.         break;
  837.     case TK_CONFIG_JOIN_STYLE:
  838.         result = Tk_NameOfJoinStyle(*((int *) ptr));
  839.         break;
  840.     case TK_CONFIG_PIXELS:
  841.         sprintf(buffer, "%d", *((int *) ptr));
  842.         result = buffer;
  843.         break;
  844.     case TK_CONFIG_MM:
  845.         Tcl_PrintDouble(interp, *((double *) ptr), buffer);
  846.         result = buffer;
  847.         break;
  848.     case TK_CONFIG_WINDOW: {
  849.         Tk_Window tkwin;
  850.  
  851.         tkwin = *((Tk_Window *) ptr);
  852.         if (tkwin != NULL) {
  853.         result = Tk_PathName(tkwin);
  854.         }
  855.         break;
  856.     }
  857.     case TK_CONFIG_CUSTOM:
  858.         result = (*specPtr->customPtr->printProc)(
  859.             specPtr->customPtr->clientData, tkwin, widgRec,
  860.             specPtr->offset, freeProcPtr);
  861.         break;
  862.     default: 
  863.         result = "?? unknown type ??";
  864.     }
  865.     return result;
  866. }
  867.  
  868. /*
  869.  *----------------------------------------------------------------------
  870.  *
  871.  * Tk_ConfigureValue --
  872.  *
  873.  *    This procedure returns the current value of a configuration
  874.  *    option for a widget.
  875.  *
  876.  * Results:
  877.  *    The return value is a standard Tcl completion code (TCL_OK or
  878.  *    TCL_ERROR).  Interp->result will be set to hold either the value
  879.  *    of the option given by argvName (if TCL_OK is returned) or
  880.  *    an error message (if TCL_ERROR is returned).
  881.  *
  882.  * Side effects:
  883.  *    None.
  884.  *
  885.  *----------------------------------------------------------------------
  886.  */
  887.  
  888. int
  889. Tk_ConfigureValue(interp, tkwin, specs, widgRec, argvName, flags)
  890.     Tcl_Interp *interp;        /* Interpreter for error reporting. */
  891.     Tk_Window tkwin;        /* Window corresponding to widgRec. */
  892.     Tk_ConfigSpec *specs;    /* Describes legal options. */
  893.     char *widgRec;        /* Record whose fields contain current
  894.                  * values for options. */
  895.     char *argvName;        /* Gives the command-line name for the
  896.                  * option whose value is to be returned. */
  897.     int flags;            /* Used to specify additional flags
  898.                  * that must be present in config specs
  899.                  * for them to be considered. */
  900. {
  901.     Tk_ConfigSpec *specPtr;
  902.     int needFlags, hateFlags;
  903.  
  904.     needFlags = flags & ~(TK_CONFIG_USER_BIT - 1);
  905.     if (Tk_Depth(tkwin) <= 1) {
  906.     hateFlags = TK_CONFIG_COLOR_ONLY;
  907.     } else {
  908.     hateFlags = TK_CONFIG_MONO_ONLY;
  909.     }
  910.     specPtr = FindConfigSpec(interp, specs, argvName, needFlags, hateFlags);
  911.     if (specPtr == NULL) {
  912.     return TCL_ERROR;
  913.     }
  914.     interp->result = FormatConfigValue(interp, tkwin, specPtr, widgRec,
  915.         interp->result, &interp->freeProc);
  916.     return TCL_OK;
  917. }
  918.  
  919. /*
  920.  *----------------------------------------------------------------------
  921.  *
  922.  * Tk_FreeOptions --
  923.  *
  924.  *    Free up all resources associated with configuration options.
  925.  *
  926.  * Results:
  927.  *    None.
  928.  *
  929.  * Side effects:
  930.  *    Any resource in widgRec that is controlled by a configuration
  931.  *    option (e.g. a Tk_3DBorder or XColor) is freed in the appropriate
  932.  *    fashion.
  933.  *
  934.  *----------------------------------------------------------------------
  935.  */
  936.  
  937.     /* ARGSUSED */
  938. void
  939. Tk_FreeOptions(specs, widgRec, display, needFlags)
  940.     Tk_ConfigSpec *specs;    /* Describes legal options. */
  941.     char *widgRec;        /* Record whose fields contain current
  942.                  * values for options. */
  943.     Display *display;        /* X display; needed for freeing some
  944.                  * resources. */
  945.     int needFlags;        /* Used to specify additional flags
  946.                  * that must be present in config specs
  947.                  * for them to be considered. */
  948. {
  949.     register Tk_ConfigSpec *specPtr;
  950.     char *ptr;
  951.  
  952.     for (specPtr = specs; specPtr->type != TK_CONFIG_END; specPtr++) {
  953.     if ((specPtr->specFlags & needFlags) != needFlags) {
  954.         continue;
  955.     }
  956.     ptr = widgRec + specPtr->offset;
  957.     switch (specPtr->type) {
  958.         case TK_CONFIG_STRING:
  959.         if (*((char **) ptr) != NULL) {
  960.             ckfree(*((char **) ptr));
  961.             *((char **) ptr) = NULL;
  962.         }
  963.         break;
  964.         case TK_CONFIG_COLOR:
  965.         if (*((XColor **) ptr) != NULL) {
  966.             Tk_FreeColor(*((XColor **) ptr));
  967.             *((XColor **) ptr) = NULL;
  968.         }
  969.         break;
  970.         case TK_CONFIG_FONT:
  971.         if (*((XFontStruct **) ptr) != NULL) {
  972.             Tk_FreeFontStruct(*((XFontStruct **) ptr));
  973.             *((XFontStruct **) ptr) = NULL;
  974.         }
  975.         break;
  976.         case TK_CONFIG_BITMAP:
  977.         if (*((Pixmap *) ptr) != None) {
  978.             Tk_FreeBitmap(display, *((Pixmap *) ptr));
  979.             *((Pixmap *) ptr) = None;
  980.         }
  981.         break;
  982.         case TK_CONFIG_BORDER:
  983.         if (*((Tk_3DBorder *) ptr) != NULL) {
  984.             Tk_Free3DBorder(*((Tk_3DBorder *) ptr));
  985.             *((Tk_3DBorder *) ptr) = NULL;
  986.         }
  987.         break;
  988.         case TK_CONFIG_CURSOR:
  989.         case TK_CONFIG_ACTIVE_CURSOR:
  990.         if (*((Cursor *) ptr) != None) {
  991.             Tk_FreeCursor(display, *((Cursor *) ptr));
  992.             *((Cursor *) ptr) = None;
  993.         }
  994.     }
  995.     }
  996. }
  997.